Skip to main content

Config Manager deployment using Docker and Docker Compose

The Config Manager is a service that is responsible for managing the configuration of the Config Manager. It is a separate service that is deployed alongside the Config Manager.

Create a Docker Compose File​

The Docker Compose file is a YAML file that contains the configuration for the Config Manager, including the image to use, the ports to expose, and the environment variables to set.

The sample Docker Compose file definition is provided in Appendix B, but you may need to customise it to suit your environment.

info

This config assumes that the services will share a common network, called proxy, and that the Config Manager will be accessible from both the Studio and the Config Manager.

If the database services are also running in the local Docker engine, you can define an additional network to seperate and secure the network traffic between the services.

Create a new file called config-manager-compose.yml in a working directory on your PC and add the following content:

config-manager-compose.yml
services:

  one37-cm:
    container_name: one37-cm
    image: [provided-image-registryhost]/solitaire/idnext:latest
    # Optional - We don't have to expose ports directly as the services will share
    # a common network.
    #ports:
    #  - [external-port]:8083
    networks:
      - proxy
    environment:
      #Block Microsoft Telemetry
      - DOTNET_CLI_TELEMETRY_OPTOUT=1
      - AGENT_NAME=[your-agent-name]
      - PG_HOST=[your-db-host]
      - PG_PORT=[your-db-port]
      - PG_DBNAME=[your-db-name]
      - PG_USER=[your-db-user]
      - PG_PSWD=[your-db-password]
      - PG_ADMIN_USER=[your-db-admin-user]
      - PG_ADMIN_PSWD=[your-db-admin-password]
      - AGENCY_URL=https://[your-public-business-connector-hostname]
      # SCHEDULE SERVICES
      - WORKFLOW_CLEANER_SERVICE_CRON=*/1 * * * *
      - LOCAL_METRICS_ENABLED=true # Enable local metrics collection
      - STATS_BUFFER_TIME=1 # Metrics collection flush interval in minutes

    pull_policy: always
    restart: always

networks:
    proxy:
      external: true # Use the existing network defined in the Studio Docker Compose file
      name: proxy

Start the Config Manager​

To start the Config Manager, run the following command in the same directory as the Docker Compose file:

docker-compose -f config-manager-compose.yml up -d

This command will start the Config Manager and leave it running in the background.

Verify the Config Manager​

To check the status of the Config Manager, run the following command:

docker ps

This command will list all the running containers on your Docker engine.

If the Config Manager is running, you should see a container with the name one37-cm.

info

If the Config Manager fails to start, or you want to just check the logs, run the following command:

docker logs one37-cm

On the first run the output will look something like this:

[2021-09-01 12:00:00] [info] [one37-cm] Starting Config Manager...
[2021-09-01 12:00:00] [info] [one37-cm] Config Manager started successfully.

Next Steps​

After you have successfully deployed and started the application, you can proceed to the next step in the installation process.

X

Graph View